Add helpful note to edit-first-gameserver-go #3846

peterzhongyi · 2024-05-31T15:25:43Z

Add a note in case people modified the game server main.go file again and want to see their new changes reflected in new game servers.

Also added some explanation on why the imagePullPolicy needs to be changed to Always.

agones-bot · 2024-05-31T16:12:51Z

Build Failed 😱

Build Id: cf3ec87c-7b8e-4557-8737-aac31dcae81e

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2024-05-31T20:13:54Z

Build Succeeded 👏

Build Id: e2fd38c7-4887-47a7-b774-053f196cdffe

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://41d7452-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3846/head:pr_3846 && git checkout pr_3846
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.41.0-dev-41d7452-amd64

markmandel · 2024-06-04T00:52:53Z

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

+  ```
+
+Alternatively, you can also manually increment the `version` field in the `Makefile` file and change the `TAG` variable accordingly.
+However this is more cumbersome, and is not encouraged.


Why not encouraged?

Oh I guess it's just less preferred during development period because it is more cumbersome. Added some more explanations and changed the wording a bit.

markmandel · 2024-06-04T00:54:15Z

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

+{{< alert title="Note" color="info">}}
+If you made changed `main.go` again and want to apply the changes to the new game servers, then you also need 
+  to modify the `gamerserver.yaml` file's `imagePullPolicy` to be `Always`, or else the new game servers might
+  only pull a cached version of the image, which doesn't have the new changes.


I think a link to https://kubernetes.io/docs/concepts/containers/images/#updating-images would be good.

Something like "See the documentation for ImagePullPolicy" for more details.

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

agones-bot · 2024-06-04T15:47:53Z

Build Failed 😱

Build Id: cbc456b9-a5e7-4506-af28-2f72cdb3ed98

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2024-06-04T17:01:53Z

Build Failed 😱

Build Id: 8128cd89-ab01-4bfd-868a-7490fd823117

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

zmerlynn · 2024-06-04T17:12:12Z

What the heck?

Retried the build.

agones-bot · 2024-06-04T18:15:36Z

Build Succeeded 👏

Build Id: edc0bf03-cdff-4361-9b75-ee4c14f5979b

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://0f61c3c-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3846/head:pr_3846 && git checkout pr_3846
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.41.0-dev-0f61c3c-amd64

zmerlynn · 2024-06-04T18:36:18Z

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

@@ -87,6 +87,26 @@ kubectl create -f gameserver.yaml
 kubectl apply -f gameserver.yaml
 ```

+{{< alert title="Note" color="info">}}
+If you changed `main.go` again and want to apply the changes to the new game servers, then you also need 
+to modify the `gamerserver.yaml` file's `imagePullPolicy` to be `Always`, or else the new game servers might


It's not the game servers pulling a new image, it's kubelet, or just say the node.

Something like: "or the node may use a cached copy of the image, which doesn't have the new changes."

zmerlynn · 2024-06-04T18:37:00Z

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

+If you changed `main.go` again and want to apply the changes to the new game servers, then you also need 
+to modify the `gamerserver.yaml` file's `imagePullPolicy` to be `Always`, or else the new game servers might
+only pull a cached version of the image, which doesn't have the new changes. See the documentation for
+[ImagePullPolicy](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for more details.


To shorten this a bit, I would just link imagePullPolicy above and anyone curious will know to go look at the hyperlink, which would let you drop this sentence.

zmerlynn · 2024-06-04T18:39:56Z

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

+
+Alternatively, you can also manually increment the `version` field in the `Makefile` file and change the `TAG`
+variable accordingly. However this is more cumbersome because you need to increment the `version` field each
+time you want to see a new change reflected in `main.go`, so it is usually less preferred during code development.


I know you're trying to be helpful but I think line 104-107, after accordingly. can be dropped, I.e. you can present both and let people decide which toil they like better.

This is a common Kubernetes dev flow thing, so I think concision here is a little better - the note is a good reminder but a lot of people coming to the page will already be familiar with this gotcha.

Makes sense - yeah most people would know this already.

agones-bot · 2024-06-05T14:48:57Z

Build Failed 😱

Build Id: 18709d3a-1b07-4cc3-8b5f-9fc70ff9631c

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2024-06-05T16:03:50Z

Build Succeeded 👏

Build Id: 3a1728b6-d883-4a73-9090-171d71fb43ee

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://88bb6fc-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3846/head:pr_3846 && git checkout pr_3846
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.41.0-dev-88bb6fc-amd64

agones-bot · 2024-06-05T18:31:31Z

Build Succeeded 👏

Build Id: 21c6591f-d5f7-43d4-99da-520288a62183

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://25fa6d7-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3846/head:pr_3846 && git checkout pr_3846
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-25fa6d7-amd64

github-actions bot added kind/other size/S labels May 31, 2024

peterzhongyi force-pushed the docs branch from 6afaf2e to 41d7452 Compare May 31, 2024 18:49

markmandel reviewed Jun 4, 2024

View reviewed changes

peterzhongyi force-pushed the docs branch 3 times, most recently from 3f0e7e2 to 84f92fb Compare June 4, 2024 15:15

peterzhongyi commented Jun 4, 2024

View reviewed changes

site/content/en/docs/Getting Started/edit-first-gameserver-go.md Outdated Show resolved Hide resolved

zmerlynn reviewed Jun 4, 2024

View reviewed changes

Add helpful note to edit-first-gameserver-go

88bb6fc

peterzhongyi force-pushed the docs branch from 0f61c3c to 88bb6fc Compare June 5, 2024 13:47

zmerlynn approved these changes Jun 5, 2024

View reviewed changes

Merge branch 'main' into docs

25fa6d7

zmerlynn enabled auto-merge (squash) June 5, 2024 17:32

zmerlynn merged commit bc42fd5 into googleforgames:main Jun 5, 2024
4 checks passed

kamaljeeti added area/user-experience Pertaining to developers trying to use Agones, e.g. SDK, installation, etc and removed kind/other labels Jul 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add helpful note to edit-first-gameserver-go #3846

Add helpful note to edit-first-gameserver-go #3846

peterzhongyi commented May 31, 2024

agones-bot commented May 31, 2024

agones-bot commented May 31, 2024

markmandel Jun 4, 2024

peterzhongyi Jun 4, 2024

markmandel Jun 4, 2024

peterzhongyi Jun 4, 2024

agones-bot commented Jun 4, 2024

agones-bot commented Jun 4, 2024

zmerlynn commented Jun 4, 2024

agones-bot commented Jun 4, 2024

zmerlynn Jun 4, 2024

zmerlynn Jun 4, 2024

zmerlynn Jun 4, 2024

peterzhongyi Jun 5, 2024

agones-bot commented Jun 5, 2024

agones-bot commented Jun 5, 2024

agones-bot commented Jun 5, 2024

Add helpful note to edit-first-gameserver-go #3846

Add helpful note to edit-first-gameserver-go #3846

Conversation

peterzhongyi commented May 31, 2024

agones-bot commented May 31, 2024

agones-bot commented May 31, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Jun 4, 2024

agones-bot commented Jun 4, 2024

zmerlynn commented Jun 4, 2024

agones-bot commented Jun 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Jun 5, 2024

agones-bot commented Jun 5, 2024

agones-bot commented Jun 5, 2024